Skip to content

docs(cli): clarify password field limitations for main branch#5309

Merged
avallete merged 4 commits into
developfrom
claude/document-branches-password-field-EAvkJ
May 20, 2026
Merged

docs(cli): clarify password field limitations for main branch#5309
avallete merged 4 commits into
developfrom
claude/document-branches-password-field-EAvkJ

Conversation

@avallete
Copy link
Copy Markdown
Member

@avallete avallete commented May 20, 2026

Updates the help text for the branches get command in both the Go and TypeScript CLI implementations to clarify that password-dependent database fields are not populated for the main branch.

Changes:

  • Updated branchGetCmd long description in apps/cli-go/cmd/branches.go to include a note explaining that POSTGRES_URL and POSTGRES_URL_NON_POOLING fields are not available for the main branch because production database credentials cannot be retrieved via API
  • Updated the command description in apps/cli/src/legacy/commands/branches/get/get.command.ts with the same clarification for consistency across CLI implementations

This improves user experience by setting correct expectations when querying main branch details and reduces confusion about missing credential fields.

Closes: CLI-1450

https://claude.ai/code/session_01Dq9V9d8nxzfFkqk3MaHBWB

claude added 2 commits May 20, 2026 08:25
…ommand

The main branch omits POSTGRES_URL and POSTGRES_URL_NON_POOLING because
production database credentials are not retrievable via the Management API.
Add a note to the Long description so the behavior is visible in both
--help output and the auto-generated CLI reference docs.

Fixes CLI-1450
The legacy TypeScript shell is a 1:1 port of the Go CLI and must keep
help text in sync. Match the new main-branch password-field note that
was added to the Go cobra command.

Fixes CLI-1450
@avallete avallete requested a review from a team as a code owner May 20, 2026 08:28
@coveralls
Copy link
Copy Markdown

coveralls commented May 20, 2026

Coverage Report for CI Build 26151498934

Warning

No base build found for commit 022c72b on develop.
Coverage changes can't be calculated without a base build.
If a base build is processing, this comment will update automatically when it completes.

Coverage: 63.744%

Details

  • Patch coverage: No coverable lines changed in this PR.

Uncovered Changes

No uncovered changes found.

Coverage Regressions

Requires a base build to compare against. How to fix this →


Coverage Stats

Coverage Status
Relevant Lines: 15680
Covered Lines: 9995
Line Coverage: 63.74%
Coverage Strength: 7.06 hits per line

💛 - Coveralls

avallete and others added 2 commits May 20, 2026 10:36
Switching Long from a quoted string to a backtick literal changes
column alignment; gofmt wants Args: with one space instead of two.
@avallete avallete enabled auto-merge (squash) May 20, 2026 09:06
@avallete avallete merged commit e123b51 into develop May 20, 2026
17 checks passed
@avallete avallete deleted the claude/document-branches-password-field-EAvkJ branch May 20, 2026 09:10
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants